Class OSPFNeighborTableImpl

java.lang.Object
com.cisco.pt.ipc.impl.IPCObjectImpl
com.cisco.pt.ipc.sim.impl.OSPFNeighborTableImpl
All Implemented Interfaces:
IPCObject, OSPFNeighborTable

public class OSPFNeighborTableImpl extends IPCObjectImpl implements OSPFNeighborTable
Information provided by the PKI file:

    \class OspfNeighborTable
    
    \brief OspfNeighborTable handles and manipulates OSPF neighbor tables.
    
    \example network().getDevice("Router0").getProcess("OspfMainProcess").getOspfProcessAt(0).getAreaAt(0).getNeighborTable("Serial0/0/0")
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getNeighborAt

      public OSPFNeighbor getNeighborAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the neighbor at the specified index.
          
          \param index, the index of the neighbor of interest.
          
          \return OspfNeighbor, the OspfNeighbor object at the specified index.
          
              
      Specified by:
      getNeighborAt in interface OSPFNeighborTable
      Parameters:
      index - Takes in a parameter of index
      Returns:
      OSPFNeighbor Returns a OSPFNeighbor
    • getNeighborCount

      public int getNeighborCount()
      Information provided by the PKI file:
      
          \brief Returns the number of neighbors.
          
          \return int, the number of neighbors.
          
              
      Specified by:
      getNeighborCount in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getPort

      public RouterPort getPort()
      Information provided by the PKI file:
      
          \brief Returns the port of this neighbor table.
          
          \return RouterPort, the RouterPort object of this neighbor table.
          
              
      Specified by:
      getPort in interface OSPFNeighborTable
      Returns:
      RouterPort Returns a RouterPort
    • getAdjNeighborCount

      public int getAdjNeighborCount()
      Information provided by the PKI file:
      
          \brief Returns the number of adjacent neighbors.
          
          \return int, the number of adjacent neighbors.
          
              
      Specified by:
      getAdjNeighborCount in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getAdjNeighborAt

      public IPAddress getAdjNeighborAt(int index)
      Information provided by the PKI file:
      
          \brief Returns the IP address of the adjacent neighbor at the specified index.
          
          \param index, the index of the adjacent neighbor of interest.
          
          \return ip, the IP address of the adjacent neighbor at the specified index.
          
              
      Specified by:
      getAdjNeighborAt in interface OSPFNeighborTable
      Parameters:
      index - Takes in a parameter of index
      Returns:
      IPAddress Returns a IPAddress
    • getFloodLength

      public int getFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the flood length.
          
          \return int, the flood length.
          
              
      Specified by:
      getFloodLength in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getLastFloodLength

      public int getLastFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the last flood length.
          
          \return int, the last flood length.
          
              
      Specified by:
      getLastFloodLength in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getMaxFloodLength

      public int getMaxFloodLength()
      Information provided by the PKI file:
      
          \brief Returns the maximum flood length.
          
          \return int, the maximum flood length.
          
              
      Specified by:
      getMaxFloodLength in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getLastFloodTime

      public int getLastFloodTime()
      Information provided by the PKI file:
      
          \brief Returns the last flood time.
          
          \return int, the last flood time.
          
              
      Specified by:
      getLastFloodTime in interface OSPFNeighborTable
      Returns:
      int Returns a int
    • getMaxFloodTime

      public int getMaxFloodTime()
      Information provided by the PKI file:
      
          \brief Returns the maximum flood time.
          
          \return int, the maximum flood time.
          
              
      Specified by:
      getMaxFloodTime in interface OSPFNeighborTable
      Returns:
      int Returns a int